Builder

class Builder

Constructors

Builder

open fun Builder()

Functions

acceptExpired

open fun acceptExpired(acceptExpired: Boolean): TileRegionLoadOptions.Builder

Accepts expired data when loading tiles.This flag should be set to true to accept expired responses.

averageBytesPerSecond

open fun averageBytesPerSecond(@Nullable() averageBytesPerSecond: Integer): TileRegionLoadOptions.Builder

Limits the download speed of the tile region.Note that this is not a strict bandwidth limit, but only limits the average download speed.

build

open fun build(): TileRegionLoadOptions

descriptors

open fun descriptors(@Nullable() descriptors: List<TilesetDescriptor>): TileRegionLoadOptions.Builder

The tile region's tileset descriptors.If provided, updates the tile region's tileset descriptors that definethe tilesets and zoom ranges of the tiles for the tile region.Providing an empty tileset descriptors list is equivalent to removeTileRegion() call.

extraOptions

open fun extraOptions(@Nullable() extraOptions: Value): TileRegionLoadOptions.Builder

Extra tile region load options.If provided, contains an object value with extra tile region load options.There are currently no extra options.

geometry

open fun geometry(@Nullable() geometry: Geometry): TileRegionLoadOptions.Builder

The tile region's associated geometry.If provided, updates the tile region's associated geometry i.e.

metadata

open fun metadata(@Nullable() metadata: Value): TileRegionLoadOptions.Builder

A custom Mapbox Value associated with this tile region for storing metadata.If provided, the custom value value will be stored alongside the tile region.

networkRestriction

open fun networkRestriction(@NonNull() networkRestriction: NetworkRestriction): TileRegionLoadOptions.Builder

Controls which networks may be used to load the tile.By default, all networks are allowed.

startLocation

open fun startLocation(@Nullable() startLocation: Point): TileRegionLoadOptions.Builder

Starts loading the tile region at the given location and then proceeds to tiles that are further awayfrom it.Note that this functionality is not currently implemented.